SGI Freeware 1999 August

home *** CD-ROM | disk | FTP | other *** search

/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_hylafax.idb / usr / freeware / man / cat1 / faxstat.Z / faxstat

Wrap

Text File | 1999-07-16 | 22.2 KB | 462 lines

FFFFAAAAXXXXSSSSTTTTAAAATTTT((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 9999,,,, 1111999999996666)))) FFFFAAAAXXXXSSSSTTTTAAAATTTT((((1111)))) NNNNAAAAMMMMEEEE faxstat - display _H_y_l_a_F_A_X status SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS ffffaaaaxxxxssssttttaaaatttt [ _o_p_t_i_o_n_s ] DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN _f_a_x_s_t_a_t reports the status of _H_y_l_a_F_A_X servers, including (potentially) the status of the send, receive, done, document, and archive directories. When invoked without options _f_a_x_s_t_a_t reports only the status of the server; the options described below can be used to override this behaviour. Server status information indicates the state of the server (idle, sending, receiving, etc.) and the phone number that is associated with the fax modem. The job queue report give the status of facsimile jobs queued for transmission; by default: +o the job identifier, +o the job state (see below for the description of the aaaa format in the JJJJoooobbbbFFFFmmmmtttt string), +o the modem or modem class the job is bound to (``any'' if the job can be sent though any modem), +o the destination (phone number) of the job, +o the time to send the job, or a blank field if the job is being processed or is to be sent immediately, +o the job's owner, +o and status information about the job (typically the reason why a previous attempt failed). The receive queue report lists the facsimile documents that have been received and are awaiting delivery; by default it includes: +o the document protection mode, +o the number of pages, +o the document's owner, +o the phone number of the sender (if supplied), +o the date and time at which the job was received, and Page 1 (printed 6/24/99) FFFFAAAAXXXXSSSSTTTTAAAATTTT((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 9999,,,, 1111999999996666)))) FFFFAAAAXXXXSSSSTTTTAAAATTTT((((1111)))) +o the filename of the document in the rrrreeeeccccvvvvqqqq directory on the server machine. OOOOPPPPTTTTIIIIOOOONNNNSSSS ----aaaa Display the status of all jobs that are stored in the aaaarrrrcccchhhhiiiivvvveeee directory on the server machine (_N_B: _t_h_i_s _w_i_l_l _a_l_w_a_y_s _b_e _e_m_p_t_y _f_o_r _v_4._0 _b_e_c_a_u_s_e _t_h_e_r_e _i_s _n_o _s_u_p_p_o_r_t _f_o_r _j_o_b _a_r_c_h_i_v_i_n_g). ----dddd Display the status of all jobs that have completed; i.e. those jobs located in the ddddoooonnnneeeeqqqq directory on the server machine. The JJJJoooobbbbFFFFmmmmtttt string defines the content and format of information reported with this option. ----ffff Display the status of document files located in the ddddooooccccqqqq directory on the server machine. The FFFFiiiilllleeeeFFFFmmmmtttt string defines the content and format of information reported with this option (see below). ----gggg Display times and dates in Greenwich Mean Time (GMT). NB: _t_h_i_s _i_s _t_h_e _d_e_f_a_u_l_t. ----hhhh _h_o_s_t Report the status of the server on a specific _h_o_s_t. The _h_o_s_t may be either a symbolic name or a network address. If no ----hhhh option is supplied, _f_a_x_s_t_a_t uses the FAXSERVER environment variable to identify the _H_y_l_a_F_A_X server to contact. If this variable is not set, then _f_a_x_s_t_a_t checks for a setting in the configuration files (first in the per-user file and then in the system-wide file). If all of the above fails, then _f_a_x_s_t_a_t attempts to contact a server on the machine where it is run. ----iiii Display additional status information for the server. This status typically has information such as the _H_y_l_a_F_A_X version, the physical location of the server machine, and an administrative contact for the server. ----llll Display times and dates in the local timezone of the server. ----rrrr Display the receive queue status for each server. The RRRRccccvvvvFFFFmmmmtttt string defines the content and format of information reported with this option (see below). ----ssss Display the status of jobs in the send queue on the server machine. The JJJJoooobbbbFFFFmmmmtttt string defines the content and format of information reported with Page 2 (printed 6/24/99) FFFFAAAAXXXXSSSSTTTTAAAATTTT((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 9999,,,, 1111999999996666)))) FFFFAAAAXXXXSSSSTTTTAAAATTTT((((1111)))) this option (see below). ----vvvv Trace the protocol exchanges between _f_a_x_s_t_a_t and the _h_f_a_x_d processes on the standard output. CCCCOOOONNNNFFFFIIIIGGGGUUUURRRRAAAATTTTIIIIOOOONNNN PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS _f_a_x_s_t_a_t reads configuration information from the file ////uuuussssrrrr////ffffrrrreeeeeeeewwwwaaaarrrreeee////lllliiiibbbb////ffffaaaaxxxx////hhhhyyyyllllaaaa....ccccoooonnnnffff and then from the file ~~~~////....hhhhyyyyllllaaaarrrrcccc. Configuration files follow the conventions described in _h_y_l_a_f_a_x(1). The following configuration parameters are recognized: TTTTaaaagggg TTTTyyyyppppeeee DDDDeeeeffffaaaauuuulllltttt DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn FileFmt string _s_e_e _b_e_l_o_w format string for file status results Host string localhost host to contact for service JobFmt string _s_e_e _b_e_l_o_w format string for job status results ModemFmt string _s_e_e _b_e_l_o_w format string for modem status results Port integer 4559 port to use in contacting server Protocol string tcp protocol to use in contacting server RcvFmt string _s_e_e _b_e_l_o_w format string for received facsimile status results TimeZone string GMT timezone to use for reporting dates and times Verbose boolean No whether or not to enable protocol tracing The configuration parameters are explained below: FFFFiiiilllleeeeFFFFmmmmtttt The format string to use when returning file status information with the ----ffff option. Formats are specified using _p_r_i_n_t_f(3S)-style conventions but using the field identifiers listed below. Each item can include field width, precision, left-justification, 0- filling, etc. just as for _p_r_i_n_t_f; e.g. %-8p for an 8-character wide, left-justified, blank-padded field containing the file protection flags. FFFFoooorrrrmmmmaaaatttt DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn a Last access time c Creation time d Device number (octal) f Filename g Group identifier (decimal) i Inode number (decimal) l Link count (decimal) m Last modification time o Owner (based on file GID) p Fax-style protection flags (no group bits) q UNIX-style protection flags r Root device number (octal) s File size in bytes (decimal) u User identifier (decimal) Page 3 (printed 6/24/99) FFFFAAAAXXXXSSSSTTTTAAAATTTT((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 9999,,,, 1111999999996666)))) FFFFAAAAXXXXSSSSTTTTAAAATTTT((((1111)))) HHHHoooosssstttt The host to contact for service. (Equivalent to the ----hhhh option.) JJJJoooobbbbFFFFmmmmtttt The format string to use when returning job status information for the ----ssss and ----dddd options. Formats are specified using _p_r_i_n_t_f(3S)-style conventions but using the field identifiers listed below. Each item can include field width, precision, left-justification, 0- filling, etc. just as for _p_r_i_n_t_f; e.g. %-3j for a 3-character wide, left-justified, blank-padded field containing the job state. FFFFoooorrrrmmmmaaaatttt DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn A Destination SubAddress B Destination Password C Destination company name D Total # dials/maximum # dials E Desired signalling rate F Client-specific tagline format string G Desired min-scanline time H Desired data format I Client-specified scheduling priority J Client-specified job tag string K Desired use of ECM (one-character symbol) L Destination geographic location M Notification e-mail address N Desired use of private tagline (one-character symbol) O Whether to use continuation cover page (one-character symbol) P # pages transmitted/total # pages to transmit Q Client-specified minimum acceptable signalling rate R Destination person (receiver) S Sender's identity T Total # tries/maximum # tries U Page chopping threshold (inches) V Job done operation W Communication identifier X Job type (one-character symbol) a Job state (one-character symbol) b # consecutive failed tries c Client machine name d Total # dials e Public (external) format of dialstring f # consecutive failed dials g Group identifier h Page chop handling (one-character symbol) i Current scheduling priority j Job identifier k Job kill time l Page length in mm m Assigned modem Page 4 (printed 6/24/99) FFFFAAAAXXXXSSSSTTTTAAAATTTT((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 9999,,,, 1111999999996666)))) FFFFAAAAXXXXSSSSTTTTAAAATTTT((((1111)))) n E-mail notification handling (one-character symbol) o Job owner p # pages transmitted q Job retry time (MM::SS) r Document resolution in lines/inch s Job status information from last failure t Total # tries attempted u Maximum # tries v Client-specified dialstring w Page width in mm x Maximum # dials y Total # pages to transmit z Time to send job The KKKK format produces: ``D'' if ECM is to be disabled, `` '' (space) if ECM use is enabled, ``H'' if T.30 Annex C half duplex is enabled, or ``F'' if T.30 Annex C full duplex is enabled. The NNNN format produces: `` '' (space) if the system-wide tagline format is to be used or ``P'' if a private tagline format is to be used. The OOOO format produces: ``N'' if no continuation cover page is to be used or `` '' (space) if the system default handling for continuation cover pages is to be used. The XXXX format produces: ``F'' for a facsimile job or ``P'' for a pager job. The aaaa format produces: ``?'' for a job in an undefined state, ``T'' for a suspended job (not being scheduled), ``P'' for a pending job (waiting for its time to send to arrive), ``S'' for a sleeping job (waiting for a scheduled timeout such as a delay between attempts to send), ``B'' for a job blocked by concurrent activity to the same destination, ``W'' for a job waiting for resources such as a free modem, ``R'' for a job that is actively running, and ``D'' for a job that is done. The hhhh format produces: ``D'' if page chopping is disabled, `` '' (space) for the system default page chop handling, ``A'' when all pages are to be chopped, or ``L'' if only the last page is to be chopped. The nnnn format produces: `` '' (space) when no Page 5 (printed 6/24/99) FFFFAAAAXXXXSSSSTTTTAAAATTTT((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 9999,,,, 1111999999996666)))) FFFFAAAAXXXXSSSSTTTTAAAATTTT((((1111)))) notification messages are to be delivered, ``D'' when notification is to be sent when the job is done, ``Q'' when notification is to be sent each time the job is requeued, or ``A'' when notification is to be sent for either the job completing or being requeued. It is recommended that all items include a field width so that the width of column title strings can be constrained when constructing headers from the format string. MMMMooooddddeeeemmmmFFFFmmmmtttt The format string to use when returning modem status information. Formats are specified using _p_r_i_n_t_f(3S)-style conventions but using the field identifiers listed below. Each item can include field width, precision, left- justification, 0-filling, etc. just as for _p_r_i_n_t_f; e.g. %-8h for an 8-character wide, left-justified, blank-padded field containing the name of the host the server is running on. FFFFoooorrrrmmmmaaaatttt DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn h Server hostname l Local identifier string m Canonical modem name n FAX phone number r Maximum pages that can be received in a single call s Status information string t Server and session tracing levels (xxxxx:yyyyy) v Modem speaker volume as one-character symbol z A ``*'' if a _f_a_x_g_e_t_t_y(1M) process is running; otherwise `` '' (space) PPPPoooorrrrtttt The network port to contact for service. (Eqvuialent to the ----hhhh option.) PPPPrrrroooottttooooccccoooollll The name of the communication protocol to use when contacting a server. (Equivalent to the FFFFAAAAXXXXSSSSEEEERRRRVVVVIIIICCCCEEEE environment variable.) RRRRccccvvvvFFFFmmmmtttt The format string to use when returning status information for the ----rrrr option. Formats are specified using _p_r_i_n_t_f(3S)-style conventions but using the field identifiers listed below. Each item can include field width, precision, left-justification, 0-filling, etc. just as for _p_r_i_n_t_f; e.g. %-3b for a 3-character wide, left-justified, blank-padded field containing the signalling rate. Page 6 (printed 6/24/99) FFFFAAAAXXXXSSSSTTTTAAAATTTT((((1111)))) UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV ((((JJJJuuuullllyyyy 9999,,,, 1111999999996666)))) FFFFAAAAXXXXSSSSTTTTAAAATTTT((((1111)))) FFFFoooorrrrmmmmaaaatttt DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn a SubAddress received from sender (if any) b Signalling rate used during receive d Data format used during receive e Error description if an error occurred during receive f Document filename (relative to the rrrreeeeccccvvvvqqqq directory) h Time spent receiving document (HH:MM:SS) l Page length in mm m Fax-style protection mode string (``-rwxrwx'') n File size (number of bytes) o File owner p Number of pages in document q UNIX-style protection flags r Resolution of received data s Sender identity (TSI) t Compact representation of the time when the receive happened w Page width in mm z A ``*'' if receive is going on; otherwise `` '' (space) It is recommended that all items include a field width so that the width of column title strings can be constrained when constructing headers from the format string. TTTTiiiimmmmeeeeZZZZoooonnnneeee Control whether times and dates are reported in the local timezone of the server (``local'') or in GMT (``gmt''). By default times are reported in GMT. VVVVeeeerrrrbbbboooosssseeee Control protocol tracing. (Equivalent to the ----vvvv option.) BBBBUUUUGGGGSSSS There is no way to suppress the server status report. There is no way to control the printing of headers. FFFFIIIILLLLEEEESSSS /usr/freeware/lib/fax/hyla.conf system-wide configuration file ~/.hylarc per-user configuration file SSSSEEEEEEEE AAAALLLLSSSSOOOO _h_y_l_a_f_a_x(1), _s_e_n_d_f_a_x(1), _f_a_x_a_l_t_e_r(1), _f_a_x_r_m(1), _h_f_a_x_d(1M) Page 7 (printed 6/24/99)